v2.7.0

Compare Source

New Features

• Added NetworkDriver.GetStatistics method to get statistics about the current session. These are network-level statistics that can be useful to assess information like bandwidth usage, packet size distribution, etc.
• Added NetworkDriver.GetConnectionStatistics method to get statistics about a specific connection. These are mostly focused around latency ("ping") and other network quality information (packet loss, duplication, etc.).
• NetworkEndpoint.Parse and NetworkEndpoint.TryParse now have variants taking FixedString128Bytes arguments instead of managed strings. Those can be used in Burst-compiled code.
• It is now possible to send an arbitrary payload when accepting a connection, similar to how it is possible to send one when establishing a connection. The buffer provided to NetworkDriver.SetAcceptPayload will be made available to clients when they pop a Connect event. The buffer's content will be in the DataStreamReader returned alongside the event.

Changes

• NetworkDriver.CheckHostnameLookupStatus has been marked as obsolete. It is an implementation detail that shouldn't be called directly by users. Instead, regular connection events (Connect/Disconnect) can be used to infer the status of the hostname lookup (there is a dedicated HostNotFound disconnect reason if a connection couldn't be established because of a hostname lookup failure).
• All functionality of TransportFunctionPointer except constructing one from a Burst-compatible delegate is now deprecated. Mostly this is just cleaning up old unused APIs as using managed delegates in pipeline stages has not been possible for a very long time.

Fixes

• Addressed an issue where transient socket errors would be considered as a socket failure on UDP, leading to a useless re-creation of the socket. This would generally manifest as an error about receive requests being marked as failed.
• Prevented a situation where a write could occur on a closed TCP socket, potentially resulting in a crash on Linux.
• Fixed a bug when using Relay and DTLS where a disconnection would fail to be reported if the application stopped updating for a while (e.g. was put in the background on mobile) and then started updating again after the Relay allocation had timed out.
• Fixed a bug when using Relay and DTLS where the driver would fail to reconnect to the server after re-homing (i.e. after the local IP address changes, which can happen when roaming on mobile).
• Fixed runtime errors on multithreaded WebAssembly builds.
• Fixed a packet corruption bug in ReliableSequencedPipelineStage that would occur if window size was larger than 64 and a packet had to be resent multiple times.

v2.6.0

Compare Source

New Features

• It is now possible to increase the reliable pipeline window size past 64. The maximum is technically 2040 but it is strongly recommended to stick to 256 or below. The documentation has more details on this change.
• Added a new NetworkDriver.GetMaxSupportedPayloadSize method that can be used to find out what the maximum payload size is on a given connection/pipeline. It's equivalent to fetching the Capacity property of the DataStreamWriter returned by BeginSend on the same connection and pipeline, but does not require acquiring a packet buffer like BeginSend does.

Changes

• Integration with the logging package (com.unity.logging) has been removed. Logs are now only written to the default Debug.Log mechanism. This should have no impact even to most users of the logging package, since its default configuration forwards Debug.Log logs to the default logger.
• When using the reliable pipeline stage, the configured window size will now always be internally rounded up to the next multiple of 8 (if not already one). This change should be completely transparent to everyone, as the only impact is slightly improved bandwidth if using an atypical window size.
• NetworkDriver.GetMaxSupportedMessageSize can now return different negative values to represent different errors. All values map to the Error.StatusCode enum.
• Updated the Burst package dependency to version 1.8.24.
• Updated the Mathematics package dependency to version 1.3.2.

Fixes

• Fixed an issue where the DF (don't fragment) bit would be set even when MTU discovery was disabled, which could cause problems in environments where the MTU is more limited (like with some VPN providers).
• Prevented an extraneous error from being logged when a send would fail within a pipeline (which already logs an error).
• Fixed a bug where NetworkDriver.CheckHostnameLookupStatus would throw an exception when checking the status of connections that either did not use hostname lookup at all, or for which the hostname lookup had already finished in a previous driver update.
• Prevented an error from being shown on Windows when a UDP socket bound to an IPv4 address received IPv6 packets (or vice-versa). Such packets were always discarded anyway, but now they won't generate errors at least.
• Fixed a bug in NetworkDriver.MaxHeaderSize where it would return a size one byte larger than the actual maximum header size.
• Fixed an issue where TLS alert messages would lead to a decryption failure, leading to an error being logged even in normal disconnection scenarios.
• NetworkDriver.Bound and NetworkDriver.Listening will now return false if accessed on a disposed driver, instead of throwing a NullReferenceException (or causing an application segfault if safety checks are disabled).